Querying a payment
This endpoint returns transfer/payments information. It is possible to fetch the information using the Idempotency Key (Used with the transaction id internally in the Delfinance System) or EndToEndId. Use this endpoint to fetch internal transfers sent and Pix transfers sent. Note that the information is received first by the webhook, therefore your system should prioritize webhooks for these updates.
Request
- URL
- cURL
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transfers/{transferIdentifier}'
curl --request GET \
--url https://apisandbox.delbank.com.br/baas/api/v2/transfers/{transferIdentifier} \
--header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}'
'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Path parameters
| Name | Type | Description |
|---|---|---|
| transferIdentifier | string | Required. Transfer identification. This identification can be the IdempotencyKey or the EndToEndId in a Pix transaction. |
Response
The status code 200 will indicate success in the transaction
Being successful, the return body will present the following fields in Json format:
🚧 This information will be returned after transfer creation and transfer query.
{
"id": "e051e1db-1a90-47dc-9e37-3ef2b4fc9d35",
"endToEndId": "E3822485720231012010030530986185",
"transactionNsu": 998633,
"status": "PIX_EFFECTIVE",
"type": "PIX_QR_CODE_DYNAMIC",
"amount": 5.99,
"createdAt": "2023-10-12T01:00:34.022Z",
"description": "description",
"payer": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "bxxdbde",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "BXXDBDE",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
}
}
Querying a TED External Transfer
Use this endpoint to query TED External transfers
Request
- URL
- cURL
GET 'https://apisandbox.delbank.com.br/baas/api/v2/external/transfers/ted/{transferIdentifier}'
curl --request GET \
--url https://apisandbox.delbank.com.br/baas/api/v2/transfers/ted/{transferIdentifier} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}'
'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Path parameters
| Name | Type | Description |
|---|---|---|
| transferIdentifier | string | Required. Transfer identification. This identification can be the IdempotencyKey or the EndToEndId in a Pix transaction. |
Response
The status code 200 will indicate success in the transaction
Being successful, the return body will present the following fields in Json format:
🚧 This information will be returned after transfer creation and transfer query.
{
"id": "e36ddde1-f5a3-469c-b56d-a09d4c22e87f",
"type": "TED",
"status": "DONE",
"amount": 0.01,
"createdAt": "2025-05-22T13:08:51.8766667",
"transferAt": "2025-05-22T13:08:51.8766667",
"description": "test",
"sender": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "bxxdbde",
"email": "[email protected]",
"type": "LEGAL"
},
"bank": {
"code": "435",
"name": "DELCRED SCD S.A.",
"ispbCode": "38224857"
}
},
"recipient": {
"number": "317102",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "***876977**",
"name": "HOMOLOGACAO INTEGRACAO API",
"type": "NATURAL"
},
"bank": {
"code": "001",
"name": "BANCO DO BRASIL S.A.",
"ispbCode": "00000000"
}
},
"tags": []
}